/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * Copyright (c) 2004 David Young.  All rights reserved.
 *
 * This code was written by David Young.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY David Young ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL David
 * Young BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 */
#ifndef _MAX2820REG_H_
#define	_MAX2820REG_H_

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Serial bus format for Maxim MAX2820/MAX2820A/MAX2821/MAX2821A
 * 2.4GHz 802.11b Zero-IF Transceivers
 */
#define	MAX2820_TWI_ADDR_MASK	BITS(15, 12)
#define	MAX2820_TWI_DATA_MASK	BITS(11, 0)

/*
 * Registers for Maxim MAX2820/MAX2820A/MAX2821/MAX2821A 2.4GHz
 * 802.11b Zero-IF Transceivers
 */
#define	MAX2820_TEST		0		/* Test Register */
#define	MAX2820_TEST_DEFAULT	BITS(2, 0)	/* Always set to this value. */

#define	MAX2820_ENABLE		1		/* Block-Enable Register */
#define	MAX2820_ENABLE_RSVD1	BIT(11)		/* reserved */
/*
 * Transmit Baseband Filters Enable
 * PAB_EN = SHDNB && (MAX2820_ENABLE_PAB || TX_ON)
 */
#define	MAX2820_ENABLE_PAB	BIT(10)
/*
 * Transmit Baseband Filters Enable
 * TXFLT_EN = SHDNB && (MAX2820_ENABLE_TXFLT || TX_ON)
 */
#define	MAX2820_ENABLE_TXFLT	BIT(9)
/*
 * Tx Upconverter, VGA, and Driver Amp Enable
 * TXUVD_EN = SHDNB && (MAX2820_ENABLE_TXUVD || TX_ON)
 */
#define	MAX2820_ENABLE_TXUVD	BIT(8)
/*
 * Receive Detector Enable
 * DET_EN = SHDNB && (MAX2820_ENABLE_DET || RX_ON)
 */
#define	MAX2820_ENABLE_DET	BIT(7)
/*
 * Rx Downconverter, Filters, and AGC Amps Enable
 * RXDFA_EN = SHDNB && (MAX2820_ENABLE_RXDFA || RX_ON)
 */
#define	MAX2820_ENABLE_RXDFA	BIT(6)
/*
 * Receive LNA Enable
 * AT_EN = SHDNB && (MAX2820_ENABLE_RXLNA || RX_ON)
 */
#define	MAX2820_ENABLE_RXLNA	BIT(5)
/*
 * Auto-tuner Enable
 * AT_EN = SHDNB && (MAX2820_ENABLE_AT || RX_ON || TX_ON)
 */
#define	MAX2820_ENABLE_AT	BIT(4)
/*
 * PLL Charge-Pump Enable
 * CP_EN = SHDNB && MAX2820_ENABLE_CP
 */
#define	MAX2820_ENABLE_CP	BIT(3)
/*
 * PLL Enable
 * PLL_EN = SHDNB && MAX2820_ENABLE_PLL
 */
#define	MAX2820_ENABLE_PLL	BIT(2)
/*
 * VCO Enable
 * VCO_EN = SHDNB && MAX2820_ENABLE_VCO
 */
#define	MAX2820_ENABLE_VCO	BIT(1)
#define	MAX2820_ENABLE_RSVD0	BIT(0)		/* reserved */
#define	MAX2820_ENABLE_DEFAULT \
	(MAX2820_ENABLE_AT|MAX2820_ENABLE_CP|\
	MAX2820_ENABLE_PLL|MAX2820_ENABLE_VCO)

#define	MAX2820_SYNTH		2	/* Synthesizer Register */
#define	MAX2820_SYNTH_RSVD0	BITS(11, 7)	/* reserved */
/*
 * Charge-Pump Current Select
 * 0 = +/-1mA
 * 1 = +/-2mA
 */
#define	MAX2820_SYNTH_ICP	BIT(6)
/*
 * Reference Frequency Divider
 * 0 = 22MHz
 * 1 = 44MHz
 */
#define	MAX2820_SYNTH_R_MASK	BITS(5, 0)
#define	MAX2820_SYNTH_R_22MHZ	LSHIFT(0, MAX2820_SYNTH_R_MASK)
#define	MAX2820_SYNTH_R_44MHZ	LSHIFT(1, MAX2820_SYNTH_R_MASK)
#define	MAX2820_SYNTH_ICP_DEFAULT	MAX2820_SYNTH_ICP
#define	MAX2820_SYNTH_R_DEFAULT		LSHIFT(0, MAX2820_SYNTH_R_MASK)

#define	MAX2820_CHANNEL		3	/* Channel Frequency Register */
#define	MAX2820_CHANNEL_RSVD	BITS(11, 7)	/* reserved */
/*
 * Channel Frequency Select
 * fLO = 2400MHz + CF * 1MHz
 */
#define	MAX2820_CHANNEL_CF_MASK	BITS(6, 0)
#define	MAX2820_CHANNEL_RSVD_DEFAULT	LSHIFT(0, MAX2820_CHANNEL_RSVD)
#define	MAX2820_CHANNEL_CF_DEFAULT	LSHIFT(37, MAX2820_CHANNEL_CF_MASK)

/*
 * Receiver Settings Register
 * MAX2820/MAX2821
 */
#define	MAX2820_RECEIVE		4
/*
 * VGA DC Offset Nulling Parameter 2
 */
#define	MAX2820_RECEIVE_2C_MASK	BITS(11, 9)
/*
 * VGA DC Offset Nulling Parameter 1
 */
#define	MAX2820_RECEIVE_1C_MASK	BITS(8, 6)
/*
 * Rx Level Detector Midpoint
 * Select
 * 11, 01 = 50.2mVp
 * 10     = 70.9mVp
 * 00     = 35.5mVp
 */
#define	MAX2820_RECEIVE_DL_MASK	BITS(5, 4)
/*
 * Special Function Select
 * 0 = OFF
 * 1 = ON
 */
#define	MAX2820_RECEIVE_SF	BIT(3)
/*
 * Receive Filter -3dB Frequency
 * Select (all frequencies are
 * approximate)
 */
#define	MAX2820_RECEIVE_BW_MASK	BITS(2, 0)
/* 8.5MHz */
#define	MAX2820_RECEIVE_BW_8_5MHZ	LSHIFT(0, MAX2820_RECEIVE_BW_MASK)
#define	MAX2820_RECEIVE_BW_8MHZ		LSHIFT(1, MAX2820_RECEIVE_BW_MASK)
#define	MAX2820_RECEIVE_BW_7_5MHZ	LSHIFT(2, MAX2820_RECEIVE_BW_MASK)
#define	MAX2820_RECEIVE_BW_7MHZ		LSHIFT(3, MAX2820_RECEIVE_BW_MASK)
#define	MAX2820_RECEIVE_BW_6_5MHZ	LSHIFT(4, MAX2820_RECEIVE_BW_MASK)
#define	MAX2820_RECEIVE_BW_6MHZ		LSHIFT(5, MAX2820_RECEIVE_BW_MASK)
#define	MAX2820_RECEIVE_2C_DEFAULT	LSHIFT(7, MAX2820_RECEIVE_2C_MASK)
#define	MAX2820_RECEIVE_1C_DEFAULT	LSHIFT(7, MAX2820_RECEIVE_1C_MASK)
#define	MAX2820_RECEIVE_DL_DEFAULT	LSHIFT(1, MAX2820_RECEIVE_DL_MASK)
#define	MAX2820_RECEIVE_SF_DEFAULT	LSHIFT(0, MAX2820_RECEIVE_SF)
#define	MAX2820_RECEIVE_BW_DEFAULT	MAX2820_RECEIVE_BW_7_5MHZ

/*
 * Receiver Settings Register,
 * MAX2820A/MAX2821A
 */
#define	MAX2820A_RECEIVE	4
/* VGA DC Offset Nulling Parameter 2 */
#define	MAX2820A_RECEIVE_2C_MASK	BITS(11, 9)
#define	MAX2820A_RECEIVE_2C_DEFAULT	LSHIFT(7, MAX2820A_RECEIVE_2C_MASK)
/* VGA DC Offset Nulling Parameter 1 */
#define	MAX2820A_RECEIVE_1C_MASK	BITS(8, 6)
#define	MAX2820A_RECEIVE_1C_DEFAULT	LSHIFT(7, MAX2820A_RECEIVE_1C_MASK)
#define	MAX2820A_RECEIVE_RSVD0_MASK	BITS(5, 3)
#define	MAX2820A_RECEIVE_RSVD0_DEFAULT	LSHIFT(2, MAX2820A_RECEIVE_RSVD0_MASK)
#define	MAX2820A_RECEIVE_RSVD1_MASK	BITS(2, 0)
#define	MAX2820A_RECEIVE_RSVD1_DEFAULT	LSHIFT(2, MAX2820_RECEIVE_RSVD1_MASK)

#define	MAX2820_TRANSMIT	5	/* Transmitter Settings Reg. */
#define	MAX2820_TRANSMIT_RSVD_MASK	BITS(11, 4)	/* reserved */
/*
 * PA Bias Select
 * 15 = Highest
 * 0 = Lowest
 */
#define	MAX2820_TRANSMIT_PA_MASK	BITS(3, 0)
#define	MAX2820_TRANSMIT_PA_DEFAULT	LSHIFT(0, MAX2820_TRANSMIT_PA_MASK)

#ifdef __cplusplus
}
#endif

#endif /* _MAX2820REG_H_ */
